fix(feedback): Update docs on Feedback attachments #16219
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
coolguyzone
reviewed
Feb 3, 2026
| "name": "John Smith" | ||
| } | ||
| } | ||
| {"type":"attachment","length":1234,"filename":"screenshot.png"} |
Contributor
There was a problem hiding this comment.
I don't have a lot of context here, but it's unclear to me what the 'length' key is referencing here. Will this be something obvious to someone working on a feedback context object? If not, I recommend adding an explainer.
Member
Author
There was a problem hiding this comment.
The length refers to the payload size of the following segment (e.g., <binary screenshot data>). Since we're (supposed to be) adding this to every envelope item already, I think it's fine not to go into details here (as this is already described in detail in the Envelope docs)
coolguyzone
approved these changes
Feb 3, 2026
Contributor
coolguyzone
left a comment
coolguyzone
left a comment
There was a problem hiding this comment.
Left a quick question in a comment, otherwise looks good to me!
jaffrepaul
pushed a commit
that referenced
this pull request
Feb 9, 2026
**Before** - https://develop.sentry.dev/sdk/telemetry/feedbacks/#attaching-screenshots - https://develop.sentry.dev/sdk/data-model/envelope-items/#user-feedback:~:text=Attaching%20Screenshots%3A **After** (awaiting vercel preview) ## DESCRIBE YOUR PR With this PR in native getsentry/sentry-native#1414 we noticed the docs are outdated, since Feedback can get more than just screenshots attached (see [this event](https://sentry-sdks.sentry.io/issues/feedback/?feedbackSlug=sentry-native%3A7227469676&mailbox=ignored&project=4506178389999616&referrer=feedback_list_page&statsPeriod=14d) for example). I updated the docs to be more generic as to what someone can attach to Feedbacks. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before
After
(awaiting vercel preview)
DESCRIBE YOUR PR
With this PR in native getsentry/sentry-native#1414 we noticed the docs are outdated, since Feedback can get more than just screenshots attached (see this event for example).
I updated the docs to be more generic as to what someone can attach to Feedbacks.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: